Add helpful error for renamed Wasm module #799
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Bromeon
added
quality-of-life
|
API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-799 |
Bromeon
reviewed
Jul 14, 2024
godot-macros/src/gdextension.rs
Outdated
| @@ -54,6 +54,11 @@ pub fn attribute_gdextension(item: venial::Item) -> ParseResult<TokenStream> { | |||
| let script = std::ffi::CString::new(concat!( | |||
| "var pkgName = '", env!("CARGO_PKG_NAME"), "';", r#" | |||
| var libName = pkgName.replaceAll('-', '_') + '.wasm'; | |||
| if (!(libName in LDSO.loadedLibsByName)) { | |||
| // Always print to console, avoid problems with automatic error suppression. | |||
| console.error(`gdext could not find the Wasm module '${libName}', needed to load the '${pkgName}' crate's GDExtension. Please ensure a file named '${libName}' exists in the game's web export files.`); | |||
There was a problem hiding this comment.
needed to load the '${pkgName}' crate's GDExtension.
Does the "GDExtension" part really add something, or could this be simplified to
needed to load the '${pkgName}' crate.
There was a problem hiding this comment.
Also maybe you can call it "godot-rust" instead of "gdext". This could be useful in case someone uses multiple languages or extensions.
There was a problem hiding this comment.
I agree! It looks like this now:
PgBiel
force-pushed
the
error-renamed-wasm
branch
from
4102319 to
afd47f1
Compare
|
Thank you! 🙂 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
An initial countermeasure for the problem at #438 (comment) - we just throw an error if
${crate_name_with_underscores}.wasmdoesn't exist when it should. The error message needs some improvement, but at least I could test this approach and it produces the result below.Right now, I just throw an error with a summarized description of the problem and print a longer error to console. But I think there's some improvement to be had here, I'm open for suggestions. Maybe we can just throw the error with the full message anyway, or we can append "Check the browser console for more details" to the error message.